home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / misc / ami2guidev1a.lha / aminet2guide / Aminet2Guide.doc < prev    next >
Encoding:
Text File  |  1995-02-10  |  6.0 KB  |  183 lines
  1.  
  2. Aminet2Guide - Converts file containing Aminet RECENT or INDEX listing
  3.                into AmigaGuide format; AmigaGuide can then be used for
  4.                retrieving files from Aminet via Term
  5.  
  6.  
  7. Copyright ©1994 by Timothy B. Kreuzer.  All rights reserved.
  8.  
  9. Version: 1.0a
  10.  
  11. Author: Tim Kreuzer
  12.  
  13. Language: SAS/C V6.5
  14.  
  15.  
  16. Description
  17. -----------
  18. "Aminet2Guide" is a CLI-only command which accepts a file containing
  19. a RECENT or INDEX listing obtained from Aminet, and converts it into
  20. an AmigaGuide database file.  The AmigaGuide database file can then
  21. be used in combination with the Term telecommunications program in
  22. order to either download binary files or view the ".readme" files by
  23. simply selecting a button containing the file's name.
  24.  
  25.  
  26. Version Information
  27. -------------------
  28. Version 1.0a : Adjustments to the expected location/size of the various
  29.                fields within the Aminet RECENT/INDEX listings, due to
  30.                a recent (unexpected) change in the listings themselves
  31.  
  32. Version 1.0  : Initial release
  33.  
  34.  
  35. Usage
  36. -----
  37. Aminet2Guide [path]infile [path]outfile
  38.  
  39. where:  [path]infile  =  File containing Aminet RECENT or INDEX listing
  40.  
  41.         [path]outfile =  Generated AmigaGuide file, ready for usage with
  42.                          the Term telecommunications program
  43.  
  44.  
  45. Installation
  46. ------------
  47. Copy the Aminet2Guide file into your "C:" directory.
  48.  
  49.  
  50. Limitations
  51. -----------
  52. 1) Usage of the "Aminet2Guide" AmigaGuide database requires the following:
  53.  
  54.    - The Term telecommunications program
  55.    - The AmigaGuide program or MultiView (with the AmigaGuide datatype)
  56.    - ARexx
  57.  
  58. 2) The "Aminet2Guide" AmigaGuide database has only been tested/used
  59.    accessing the Aminet via the Delphi on-line service.  I am far to
  60.    ignorant of any "standard" approach to Internet access to assume that
  61.    the database will work for ANY carrier.  My hope is that it will.
  62.  
  63. 3) The "Aminet2Guide" program assumes that the following text strings
  64.    are present in the input file (in order to determine where the file
  65.    names begin):
  66.  
  67.    RECENT listings/files >> must << contain "Recent uploads to"
  68.    
  69.    INDEX listings/files >> must << contain "Contents of the"
  70.  
  71.    Note that (as of this writing) any full RECENT or INDEX listing from
  72.    Aminet will contain these strings in the header.
  73.  
  74. 4) The file directory information is not included in the output AmigaGuide
  75.    database, in order to fit all the information for a single file onto
  76.    an 80 character line
  77.    
  78.  
  79. Example
  80. -------
  81.  1) Using Term, access the Aminet via your preferred carrier.
  82.  
  83.  2) Make sure the Term buffer is in "Recording" mode (i.e., you have
  84.     not selected "Freeze buffer" from Term's "Buffer" menu).
  85.  
  86.  3) Issue the command(s) to display a listing of either an Aminet RECENT
  87.     or INDEX file.
  88.  
  89.     Assume for this example you have displayed an Aminet RECENT listing
  90.     by typing the commands: 
  91.  
  92.        ascii           <return>   and 
  93.        get "RECENT" TT <return>
  94.  
  95.     while at the main Aminet directory level.
  96.  
  97.  4) Save the Term buffer (containing the Aminet RECENT or INDEX listing)
  98.     to disk using the "Save Buffer as..." option of the "Buffer" menu.
  99.  
  100.     Assume for this example you have saved the buffer containing the
  101.     INDEX listing to "RAM:Aminet_RECENT".
  102.  
  103.  5) Switch back to the Workbench screen.  From a shell, issue the following
  104.     command:
  105.  
  106.        Aminet2Guide RAM:Aminet_RECENT RAM:Aminet_RECENT.guide
  107.  
  108.  6) When you are returned to the shell prompt, you will now have a file
  109.     called Aminet_RECENT.guide on your RAM: disk.
  110.  
  111.  7) Switch back the Term screen.  Select the "Screen..." option from the
  112.     "Settings" menu.  This will cause the "Screen Settings" window to open.
  113.  
  114.  8) Select the "Shanghai windows" option on the "Screen Settings" window,
  115.     then select "Use".
  116.  
  117.  9) Switch back the Workbench screen.  Make sure the ARexx is active 
  118.     (issue the "RexxMast" command if you want to be certain).
  119.  
  120. 10) Issue the following command from the shell:
  121.  
  122.        AmigaGuide RAM:Aminet_RECENT.guide   or perhaps
  123.  
  124.        MultiView RAM:Aminet_RECENT.guide
  125.  
  126.     This should cause a AmigaGuide window, containing the contents of
  127.     the converted Aminet RECENT listing to be displayed on the Term
  128.     screen.
  129.  
  130. 11) Switch back to the Term screen (if you aren't already there).
  131.  
  132.     MAKE SURE you're at the Aminet directory level corresponding with
  133.     where you obtained the converted RECENT or INDEX listing.
  134.  
  135.     If you've just gotten the listing, you're already there.
  136.  
  137. 12) Resize the AmigaGuide window so you can see the bottom of the Term
  138.     screen.
  139.  
  140.     Note that this is NOT required, but I sure like to see what's going
  141.     on!
  142.  
  143. 13) You're now set to retrieve files and/or read ".readme" files simply
  144.     by pushing a button!
  145.  
  146.     By selecting the button with a filename on it, the AmigaGuide
  147.     database will issue (to Term) a "binary" command, followed by
  148.     a "get <filename>".
  149.  
  150.     By selecting the "+" button next to a filename, the AmigaGuide
  151.     database will issue (to Term) an "ascii" command, followed by a
  152.     "get <filename>.readme TT".
  153.  
  154.     The file's size and it's short description are listed next to the
  155.     file's name in order to allow you to browse through the AmigaGuide
  156.     window to see what file's you may be interested in.
  157.  
  158. 14) When you're done downloading and/or reading "readme"'s, simply quit
  159.     the AmigaGuide window.
  160.  
  161.     You may want to also set the Term screen back to having "Shanghai
  162.     windows" turned off.  This is purely optional.
  163.  
  164. Of course, the above example assumes a number of things which you can
  165. make easier by setting things up in advance of your Aminet session, such
  166. as having ARexx active, having a shell open on the Workbench screen, and
  167. having the Term screen set to "Shanghai windows".
  168.  
  169. Also, the above is not necessarily the ONLY way in which Aminet2Guide or
  170. it's output AmigaGuide database file could be used.  It is, however,
  171. guaranteed (boy, that's a strong statement) to work this way.
  172.  
  173.  
  174. Feedback
  175. -------
  176. I'd be interesting in knowing if you find Aminet2Guide useful, or if you
  177. have any problems (or questions/suggestions).
  178.  
  179. I can be reached via Internet at the following address:
  180.  
  181.    tkreuzer@delphi.com
  182.  
  183.